| Package | au.digitalhealth.cda.schema |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R5 |
| Source | http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-au-InformationRecipient.html |
| Url | http://ns.electronichealth.net.au/cda/StructureDefinition/au-InformationRecipient |
| Version | 1.0.0 |
| Status | active |
| Date | 2024-12-13T03:13:00+00:00 |
| Name | au-InformationRecipient |
| Title | ADHA InformationRecipient (CDA Class) |
| Experimental | False |
| Realm | au |
| Authority | national |
| Description | **Australian adaptation of the [HL7 International CDA InformationRecipient class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-InformationRecipient.html)**. This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA |
| Copyright | Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/). |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient |
| Kind | logical |
| StructureDefinition | |
au-ClinicalDocument  | ADHA ClinicalDocument (CDA Class) |
| StructureDefinition | |
| http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot | InfrastructureRoot (Base Type for all CDA Classes) |
| au-IntendedRecipient | ADHA IntendedRecipient (CDA Class) |
| http://hl7.org/cda/stds/core/StructureDefinition/cs-simple | cs: Coded Simple Value |
| http://terminology.hl7.org/ValueSet/v3-xInformationRecipient | x_InformationRecipient |
Note: links and images are rebased to the (stated) source
Represents a recipient who should receive a copy of the document.
NOTE: The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.
Where a person is the intended recipient (IntendedRecipient class), the playing entity is a person (Person class), optionally scoped by an organization (Organization class). Where the intended recipient is an organization, the IntendedRecipient.classCode is valued with "ASSIGNED", and the recipient is reflected by the presence of a scoping Organization, without a playing entity. Where a health chart is the intended recipient, the IntendedRecipient.classCode is valued with "HLTHCHRT" (health chart). In this case there is no playing entity, and an optional scoping organization (Organization class).
FHIR{
"resourceType" : "StructureDefinition",
"id" : "au-InformationRecipient",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Represents a recipient who should receive a copy of the document.</p>\n <p>NOTE: The information recipient is an entity to whom a copy of a document is directed, at the time of document authorship. It is not the same as the cumulative set of persons to whom the document has subsequently been disclosed, over the life-time of the patient. Such a disclosure list would not be contained within the document, and it outside the scope of CDA.</p>\n <p>Where a person is the intended recipient (IntendedRecipient class), the playing entity is a person (Person class), optionally scoped by an organization (Organization class). Where the intended recipient is an organization, the IntendedRecipient.classCode is valued with "ASSIGNED", and the recipient is reflected by the presence of a scoping Organization, without a playing entity. Where a health chart is the intended recipient, the IntendedRecipient.classCode is valued with "HLTHCHRT" (health chart). In this case there is no playing entity, and an optional scoping organization (Organization class).</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "not-applicable"
}
]
}
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:v3"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "informationRecipient"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
}
],
"url" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-InformationRecipient",
"version" : "1.0.0",
"name" : "au-InformationRecipient",
"title" : "ADHA InformationRecipient (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2024-12-13T03:13:00+00:00",
"publisher" : "Australian Digital Health Agency",
"contact" : [
{
"name" : "Australian Digital Health Agency",
"telecom" : [
{
"system" : "email",
"value" : "mailto:help@digitalhealth.gov.au"
}
]
}
],
"description" : "**Australian adaptation of the [HL7 International CDA InformationRecipient class]( https://hl7.org/cda/stds/core/2.0.0-sd/StructureDefinition-InformationRecipient.html)**. \n\nThis is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "AU"
}
]
}
],
"copyright" : "Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/).",
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/cda/stds/core/StructureDefinition/InformationRecipient",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "InformationRecipient",
"path" : "InformationRecipient",
"short" : "Australian adaptation of the HL7 International CDA InformationRecipient class",
"definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "InformationRecipient.nullFlavor",
"path" : "InformationRecipient.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "InformationRecipient.realmCode",
"path" : "InformationRecipient.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "InformationRecipient.typeId",
"path" : "InformationRecipient.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "InformationRecipient.typeId.nullFlavor",
"path" : "InformationRecipient.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "InformationRecipient.typeId.assigningAuthorityName",
"path" : "InformationRecipient.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "InformationRecipient.typeId.displayable",
"path" : "InformationRecipient.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "InformationRecipient.typeId.root",
"path" : "InformationRecipient.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "InformationRecipient.typeId.extension",
"path" : "InformationRecipient.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "InformationRecipient.templateId",
"path" : "InformationRecipient.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "InformationRecipient.typeCode",
"path" : "InformationRecipient.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "InformationRecipient.typeCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "PRCP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.0"
}
},
{
"id" : "InformationRecipient.intendedRecipient",
"path" : "InformationRecipient.intendedRecipient",
"short" : "Australian-adapted IntendedRecipient class",
"min" : 1,
"max" : "1",
"base" : {
"path" : "InformationRecipient.intendedRecipient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-IntendedRecipient",
"profile" : [
"http://ns.electronichealth.net.au/cda/StructureDefinition/au-IntendedRecipient"
]
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "InformationRecipient",
"path" : "InformationRecipient",
"short" : "Australian adaptation of the HL7 International CDA InformationRecipient class",
"min" : 1,
"max" : "1"
},
{
"id" : "InformationRecipient.typeCode",
"path" : "InformationRecipient.typeCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"defaultValueCode" : "PRCP",
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-xInformationRecipient|2.0.0"
}
},
{
"id" : "InformationRecipient.intendedRecipient",
"path" : "InformationRecipient.intendedRecipient",
"short" : "Australian-adapted IntendedRecipient class",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://ns.electronichealth.net.au/cda/StructureDefinition/au-IntendedRecipient",
"profile" : [
"http://ns.electronichealth.net.au/cda/StructureDefinition/au-IntendedRecipient"
]
}
]
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.